FtMscLibEx ClassFtMscLibExNet for .NET framework 4
Support for fischertechnik TX-controller

[This is preliminary documentation and is subject to change.]

Implementation of the FtMsacLibEx API at .NET level
Inheritance Hierarchy

System Object
  FischerTechnik.FtMscLib.API FtMscLibExBase
    FischerTechnik.FtMscLib.API FtMscLibEx

Namespace: FischerTechnik.FtMscLib.API
Assembly: FtMscLibVBNet (in FtMscLibVBNet.dll) Version: 1.0.0.1 (1.0.0.10)
Syntax

public class FtMscLibEx : FtMscLibExBase

The FtMscLibEx type exposes the following members.

Constructors

  NameDescription
Public methodFtMscLibEx
Initializes a new instance of the FtMscLibEx class
Top
Methods

  NameDescription
Public methodCloseConnection
Will close an open connection
Public methodEnableCBMaskCntInChanged
API 3.X5A replacement
(extended)
Enables the event for a FastCounter input change.
Public methodEnableCBMaskCounterChanged
API 3.X8A replacement
(extended)
Enables the event for a Fast Counter value change.
Public methodEnableCBMaskUniChanged
API 3.X2A replacement
(extended)
Enables the event for a Universal Input change.
Public methodftxCloseAllDevices
API 2.09
Public methodftxCloseDevice
API 2.08
Public methodftxCloseLib
API 2.04
ftxCloseLib
Close the FtMscLibEx
Public methodftxEnumComPorts
API 2.13
Public methodftxGetAvailableComPorts
API 2.12
Function finds all available COM ports based on information in the Windows Registry and returns the number of ports. This information is managed internally in a static list for further use. To find and display the available COM ports, this function must be called first.
Public methodftxGetFirmwareStrg
API 2.18
ftxGetFirmwareStrg
Firmaware description of the master TX-C
Public methodStatic memberftxGetLibErrorString
API 2.14
ftxGetLibErrorString
Public methodftxGetLibVersion
API 2.01
ftxGetLibVersionStr
Gets the FTMscLibEx.dll version
Public methodftxGetLibVersionStr
API 2.02
ftxGetLibVersionStr
Gets the FTMscLibEx.dll version
Public methodftxGetLongNameStrg
API 2.17
ftxGetLongNameStrg
Name of the master TX-C
Public methodftxGetManufacturerStrg
API 2.15
ftxGetManufacturerStrg
Manufacturer info of this master TX-C
Public methodftxGetSerialNrStrg
API 2.19
ftxGetSerialNrStrg
Serial Number of the master TX-C
Public methodftxGetShortNameStrg
API 2.16
ftxGetShortNameStrg
Name of the master TX-C
Public methodftxInitLib
API 2.03
ftxInitLib
Opens the FtMscLibEx
Public methodftxIsHandleValid
API 2.10
Public methodftxIsLibInit
API 2.05
ftxIsLibInit
Public methodftxIsTransferActiv
API 3.03
ftxIsTransferActiv
Functions checks if the transfer area is active, i.e. if there is cyclical communication with the ROBO TX Controller.
Public methodftxOpenComDevice
API 2.07
ftxOpenComDevice
Function equivalent to function from 2.6, but the particular COM interface can be passed as a string, e.g. "COM4" or "COM32".
Public methodftxOpenComDeviceNr
API 2.06 ftxOpenComDeviceNr
Public methodftxStartTransferArea
API 3.01
ftxStartTransferArea
Function activates the transfer area in the library for online mode. The communication thread is started and carries out the IO commands in "online mode". It reads the current values from the output structure of the transfer area (configuration and output values) and sends these to the ROBO TX Controller. As a response to an IO request, the controller sends the current values and the communication
Public methodftxStopTransferArea
API 3.02
ftxStopTransferArea
Function disables transfer area communication with the ROBO TX Controller. The
communication thread is stopped. Communication with the ROBO TX Controller is stopped.
Public methodGetCBMaskCntInChanged
API 3.X6A (extended)
Get the actual mask
Public methodGetCBMaskCounterChanged
API 3.X9A Get the actual mask
Public methodGetCBMaskUniChanged
3.X3A (extended)
GetCBMaskUniChanged
Public methodGetComStatus
API 2.11
GetComStatus
Public methodGetDeviceInfo
Prints the device info into txtInfo
Public methodGetInCounterValue
API 3.18 GetInCounterValue
Function reads the current value of a counter input (counter) from the transfer area and
makes it available to an application.
Public methodGetInDisplayButtonValue
API 3.19 GetInDisplayButtonValue
Function reads the current status of the two push-button switches on the display.
The time for how long a push-button switch remains depressed is displayed.
Public methodGetInIOValue
API 3.17
GetInIOValue
Function reads the current value of a universal input from the transfer area and makes it
available to an application. The values of the universal inputs come as a response to an IO
request from the ROBO TX Controller and are updated in the transfer area.
Public methodGetRoboTxDevName
API 2.20
GetRoboTxDevName
Get the device name.
Public methodGetRoboTxDllStr
API 2.27
Public methodGetRoboTxFwStr
API 2.23
GetRoboTxFwStr
Get the firmware string of devId
Public methodGetRoboTxFwVal
API 2.24
GetRoboTxFwVal
Get the firmware as numbar of devId
Public methodGetRoboTxHwStr
API 2.25 GetRoboTxHwStr
Get the hardware identifier of devId
Public methodGetRoboTxSerialStr
API 2.26
Public methodIsCBMaskCntInChangedEnabled
API 3.X6A replacement
(extended)
Indicates if for this Fast Counter the event mechanisme has been enabled.
Public methodIsCBMaskCounterChangedEnabled
API 3.X 9A replacement
(extended)
Indicates if for this Fast Counter value change the event mechanisme has been enabled.
Public methodIsCBMaskUniChangedEnabled
API 3.X3A replacement
(extended)
Indicates if for this input the event mechanisme has been enabled.
Public methodOpenConnection
Open the connection with TX-C device
Public methodResetMotorExConfigObsolete.
ResetMotorExConfig
Public methodSetCBCounterResetted
API 3.07
SetCBCounterResetted
Public methodSetCBMaskCntInChanged
3.X5A (extended)
Set the mask
Public methodSetCBMaskCounterChanged
API 3.X8A (extended)
Set the mask
Public methodSetCBMaskUniChanged
3.X2A (extended)
SetCBMaskUniChanged
Public methodSetFtCntConfig
API 3.11
SetFtCntConfig
configures a counter input (counter); how the status of the counter is to be interpreted.
Public methodSetFtMotorConfig
API 3.12
SetFtMotorConfig
Public methodSetFtUniConfig
API 3.10
SetFtUniConfig
Public methodSetOutMotorValues
API 3.08
SetOutMotorValues
Set a pair of Outputs as full bridge output for bidirectional use.
Public methodSetOutPwmValues
API 3.09
SetOutPwmValues
Function sets the specified duty value in the transfer area for a PWM output.
Public methodStartCounterReset
API 3.06
StartCounterReset
Public methodStartMotorExCmd
API 3.13
Public methodStartMotorExCmd4
API 3.13A
StartMotorExCmd4(extended)
Function activates the intelligent motor mode for motor synchronization. The motor moves to the desired position using the shared counter information. The application shares the information that the motor has reached the end position by using a previously installed callback function (see also SetCBMotorExReached()). The function is able to managed 1,2 or 3 slaves. However all motor have their proper CBMotorExReached notification.
Public methodStartTransferArea
Start the transfer area for this instance
Public methodStopAllMotorExCmd
API 3.15
StopAllMotorExCmd
Function immediately stops the previously activated intelligent motor mode for motor
synchronization of all motors of the ROBO TX Controller by resetting the duty values as well
as the distance values in the output structure to 0.
Public methodStopMotorExCmd
API 3.14
StopMotorExCmd
Function immediately stops the previously activated intelligent motor mode for motor
synchronization of the specified motor by resetting the duty values as well as the distance
value in the output structure to 0.
Public methodStopTransferArea
Stop the transfer area for this instance
Top
Properties

  NameDescription
Public property_FtHdl
The handler for this instance
Top
Events

  NameDescription
Public eventOnButtonChanged
Notification that one of the Display Buttons has been changed
Public eventOnCntInputChanged
Notification that a Fast Counter Input has been changed of its level
Public eventOnCounterChanged
Notification that a Fast Counterits value has been changed
Public eventOnCounterResetted
Notification that a Fast Counter has been resetted
Public eventOnInputChanged
Notification that a Universal Input has been changed
Public eventOnMotorExReached
Notification that a extended Motor control has been reached the counter value
Top
Remarks

See Also

Reference